GET (/internal/v1/cards/{token}/pin)
Parameters
- token (path) (required): Internal unique identifier for the card. See CardToken model.
- X-Client-Public-Key (header) (required): Base64-encoded ECDH client public key using
secp256r1elliptic curve. See XClientPublicKey model.
Responses
200 OK
The card PIN is encrypted in the encryptedPayload field.
After decryption, the JSON structure will conform to DecryptedCardPin structure.
400 Bad Request
Bad Request Response
500 Internal Server Error
Internal server error response
Architecture
The card PIN is encrypted in the `encryptedPayload` field. After decryption, the JSON structure will conform to `DecryptedCardPin` structure.
Encrypted payload using AES-256-GCM. The encryption algorithm and KDF are fixed by convention: 1. Symmetric encryption: AES-256-GCM 2. Key derivation: HKDF-SHA256 from ECDH shared secret
Base64-encoded 12-byte IV (nonce) for AES-256-GCM.
Base64-encoded ciphertext, including the 16-byte AES-GCM authentication tag appended.
Base64-encoded ephemeral EC public key generated by the server for ECDH key agreement. The consumer is to combine this with its private key to derive the shared secret.
Base64-encoded random salt to be used with the agreed static HKDF function (HKDF-SHA256) to derive the AES-256 key from the ECDH shared secret.
No properties match your search
Try a different search term or clear the search to see all properties
Bad Request Response
urn:plmr:cards:connector:CARD_NOT_FOUND urn:plmr:cards:connector:CARD_ALREADY_TERMINATED urn:plmr:cards:connector:INVALID_CLIENT_PUBLIC_KEY urn:plmr:cards:connector:INVALID_CARD_STATE urn:plmr:cards:connector:IN_APP_PROVISION_NOT_ALLOWED urn:plmr:cards:connector:INVALID_CERTIFICATE_CHAINurn:plmr:cards:connector:NOT_BLANK urn:plmr:cards:connector:NOT_NULLNo properties match your search
Try a different search term or clear the search to see all properties
Internal server error response
urn:plmr:cards:connector:CARD_NOT_FOUND urn:plmr:cards:connector:CARD_ALREADY_TERMINATED urn:plmr:cards:connector:INVALID_CLIENT_PUBLIC_KEY urn:plmr:cards:connector:INVALID_CARD_STATE urn:plmr:cards:connector:IN_APP_PROVISION_NOT_ALLOWED urn:plmr:cards:connector:INVALID_CERTIFICATE_CHAINurn:plmr:cards:connector:NOT_BLANK urn:plmr:cards:connector:NOT_NULLNo properties match your search
Try a different search term or clear the search to see all properties